<?php
/* 
 * Copyright (c) 2011 Antoine d'Otreppe de Bouvette
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

/**
 * An @annotation in a documentation comment
 */
class Annotation {
    /**
     * The name of this annotation
     * 
     * @var string
     */
    private $name;
    
    /**
     * The value of this annotation
     * 
     * @var string
     */
    private $value;
    
    /**
     * @return string
     */
    public function getName() {
        return $this->name;
    }

    /**
     * @param string $name 
     */
    public function setName($name) {
        $this->name = $name;
    }

    /**
     *
     * @return mixed
     */
    public function getValue() {
        return $this->value;
    }

    /**
     *
     * @param mixed $value 
     */
    public function setValue($value) {
        $this->value = $value;
    }
    
    /**
     * @return string the first word of the value of this annotation 
     */
    public function extractType() {
        $parts = explode(' ', $this->value, 2);
        return $parts[0];
    }
    
    /**
     * @return string all but the first word of the value of this annotation 
     */
    public function extractDescription() {
        $parts = explode(' ', $this->value, 2);
        
        if (count($parts) > 1) {
            return trim($parts[1]);
        }
        else {
            return '';
        }
    }
}
